home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / strmv.z / strmv
Encoding:
Text File  |  2002-10-03  |  17.6 KB  |  331 lines

  1.  
  2.  
  3.  
  4. SSSSTTTTRRRRMMMMVVVV((((3333SSSS))))                                                            SSSSTTTTRRRRMMMMVVVV((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSSSTTTTRRRRMMMMVVVV, DDDDTTTTRRRRMMMMVVVV, CCCCTTTTRRRRMMMMVVVV, ZZZZTTTTRRRRMMMMVVVV - Multiplies a real or complex vector by a
  10.      real or complex triangular matrix
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      Single precision
  14.  
  15.           Fortran:
  16.                CCCCAAAALLLLLLLL SSSSTTTTRRRRMMMMVVVV ((((_u_p_l_o,,,, _t_r_a_n_s,,,, _d_i_a_g,,,, _n,,,, _a,,,, _l_d_a,,,, _x,,,, _i_n_c_x))))
  17.  
  18.           C/C++:
  19.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  20.                vvvvooooiiiidddd ssssttttrrrrmmmmvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,, ffffllllooooaaaatttt
  21.                *_a,,,, iiiinnnntttt _l_d_a,,,, ffffllllooooaaaatttt *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  22.  
  23.      Double precision
  24.  
  25.           Fortran:
  26.                CCCCAAAALLLLLLLL DDDDTTTTRRRRMMMMVVVV ((((_u_p_l_o,,,, _t_r_a_n_s,,,, _d_i_a_g,,,, _n,,,, _a,,,, _l_d_a,,,, _x,,,, _i_n_c_x))))
  27.  
  28.           C/C++:
  29.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  30.                vvvvooooiiiidddd ddddttttrrrrmmmmvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,, ddddoooouuuubbbblllleeee
  31.                *_a,,,, iiiinnnntttt _l_d_a,,,, ddddoooouuuubbbblllleeee *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  32.  
  33.      Single precision complex
  34.  
  35.           Fortran:
  36.                CCCCAAAALLLLLLLL CCCCTTTTRRRRMMMMVVVV ((((_u_p_l_o,,,, _t_r_a_n_s,,,, _d_i_a_g,,,, _n,,,, _a,,,, _l_d_a,,,, _x,,,, _i_n_c_x))))
  37.  
  38.           C/C++:
  39.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  40.                vvvvooooiiiidddd ccccttttrrrrmmmmvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,,
  41.                ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_a,,,, iiiinnnntttt _l_d_a,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  42.  
  43.           C++ STL:
  44.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  45.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  46.                vvvvooooiiiidddd ccccttttrrrrmmmmvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,,
  47.                ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_a,,,, iiiinnnntttt _l_d_a,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  48.  
  49.      Double precision complex
  50.  
  51.           Fortran:
  52.                CCCCAAAALLLLLLLL ZZZZTTTTRRRRMMMMVVVV ((((_u_p_l_o,,,, _t_r_a_n_s,,,, _d_i_a_g,,,, _n,,,, _a,,,, _l_d_a,,,, _x,,,, _i_n_c_x))))
  53.  
  54.           C/C++:
  55.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  56.                vvvvooooiiiidddd zzzzttttrrrrmmmmvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,,
  57.                ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_a,,,, iiiinnnntttt _l_d_a,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSTTTTRRRRMMMMVVVV((((3333SSSS))))                                                            SSSSTTTTRRRRMMMMVVVV((((3333SSSS))))
  71.  
  72.  
  73.  
  74.           C++ STL:
  75.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  76.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  77.                vvvvooooiiiidddd zzzzttttrrrrmmmmvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, cccchhhhaaaarrrr *_t_r_a_n_s,,,, cccchhhhaaaarrrr *_d_i_a_g,,,, iiiinnnntttt _n,,,,
  78.                ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_a,,,, iiiinnnntttt _l_d_a,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  79.  
  80. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  81.      These routines are part of the SCSL Scientific Library and can be loaded
  82.      using either the ----llllssssccccssss or the ----llllssssccccssss____mmmmpppp option.  The ----llllssssccccssss____mmmmpppp option
  83.      directs the linker to use the multi-processor version of the library.
  84.  
  85.      When linking to SCSL with ----llllssssccccssss or ----llllssssccccssss____mmmmpppp, the default integer size is
  86.      4 bytes (32 bits). Another version of SCSL is available in which integers
  87.      are 8 bytes (64 bits).  This version allows the user access to larger
  88.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  89.      by using the ----llllssssccccssss____iiii8888 option or the ----llllssssccccssss____iiii8888____mmmmpppp option. A program may use
  90.      only one of the two versions; 4-byte integer and 8-byte integer library
  91.      calls cannot be mixed.
  92.  
  93.      The C and C++ prototypes shown above are appropriate for the 4-byte
  94.      integer version of SCSL. When using the 8-byte integer version, the
  95.      variables of type iiiinnnntttt become lllloooonnnngggg lllloooonnnngggg and the <<<<ssssccccssssllll____bbbbllllaaaassss____iiii8888....hhhh>>>> header
  96.      file should be included.
  97.  
  98. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  99.      SSSSTTTTRRRRMMMMVVVV and DDDDTTTTRRRRMMMMVVVV multiply a real vector by a real triangular matrix.
  100.  
  101.      CCCCTTTTRRRRMMMMVVVV and ZZZZTTTTRRRRMMMMVVVV multiply a complex vector by a complex triangular matrix.
  102.  
  103.      These routines perform one of the following matrix-vector operations:
  104.  
  105.           _x <- _A_x
  106.  
  107.           _x <- _A_T_x
  108.  
  109.           _x <- _A_H_x (CCCCTTTTRRRRMMMMVVVV, ZZZZTTTTRRRRMMMMVVVV only)
  110.  
  111.      where _A_T is the transpose of _A, _A_H is the conjugate transpose of _A, _x is
  112.      an _n-element vector, and _A may be either a unit or nonunit _n-by-_n upper
  113.      or lower triangular matrix.
  114.  
  115.      See the NOTES section of this man page for information about the
  116.      interpretation of the data types described in the following arguments.
  117.  
  118.      These routines have the following arguments:
  119.  
  120.      _u_p_l_o      Character.  (input)
  121.                Specifies whether the matrix is upper or lower triangular, as
  122.                follows:
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSTTTTRRRRMMMMVVVV((((3333SSSS))))                                                            SSSSTTTTRRRRMMMMVVVV((((3333SSSS))))
  137.  
  138.  
  139.  
  140.                _u_p_l_o = 'U' or 'u':  _A is an upper triangular matrix.
  141.                _u_p_l_o = 'L' or 'l':  _A is a lower triangular matrix.
  142.  
  143.                For C/C++, a pointer to this character is passed.
  144.  
  145.      _t_r_a_n_s     Character.  (input)
  146.                Specifies the operation to be performed, as follows:
  147.  
  148.                _t_r_a_n_s = 'N' or 'n':  _x <- _A_x
  149.  
  150.                _t_r_a_n_s = 'T' or 't':  _x <- _A_T_x
  151.  
  152.                _t_r_a_n_s = 'C' or 'c':  _x <- _A_T_x (SSSSTTTTRRRRMMMMVVVV, DDDDTTTTRRRRMMMMVVVV), or _x <- _A_H_x
  153.                (CCCCTTTTRRRRMMMMVVVV, ZZZZTTTTRRRRMMMMVVVV)
  154.  
  155.                For C/C++, a pointer to this character is passed.
  156.  
  157.      _d_i_a_g      Character.  (input)
  158.                Specifies whether _A is unit triangular, as follows:
  159.  
  160.                _d_i_a_g = 'U' or 'u': _A is assumed to be unit triangular.
  161.                _d_i_a_g = 'N' or 'n': _A is not assumed to be unit triangular.
  162.  
  163.                For C/C++, a pointer to this character is passed.
  164.  
  165.      _n         Integer.  (input)
  166.                Specifies the order of matrix _A.  _n >= 0.
  167.  
  168.      _a         Array of dimension (_l_d_a,_n).  (input)
  169.                SSSSTTTTRRRRMMMMVVVV: Single precision array.
  170.                DDDDTTTTRRRRMMMMVVVV: Double precision array.
  171.                CCCCTTTTRRRRMMMMVVVV: Single precision complex array.
  172.                ZZZZTTTTRRRRMMMMVVVV: Double precision complex array.
  173.  
  174.                Before entry with _u_p_l_o = 'U' or 'u', the leading _n-by-_n upper
  175.                triangular part of array _a must contain the upper triangular
  176.                matrix.  The strictly lower triangular part of _a is not
  177.                referenced.
  178.  
  179.                Before entry with _u_p_l_o = 'L' or 'l', the leading _n-by-_n lower
  180.                triangular part of array _a must contain the lower triangular
  181.                matrix.  The strictly upper triangular part of _a is not
  182.                referenced.
  183.  
  184.                When _d_i_a_g = 'U' or 'u', these routines assume that all elements
  185.                of array _a that represent diagonal elements of matrix _A are 1.
  186.                In this case, neither of these routines will reference any of
  187.                the diagonal elements.
  188.  
  189.      _l_d_a       Integer.  (input)
  190.                Specifies the first dimension of _a as declared in the calling
  191.                program.  _l_d_a must be at least MMMMAAAAXXXX(1,_n).
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. SSSSTTTTRRRRMMMMVVVV((((3333SSSS))))                                                            SSSSTTTTRRRRMMMMVVVV((((3333SSSS))))
  203.  
  204.  
  205.  
  206.      _x         Array of dimension 1+(_n-1) * |_i_n_c_x|.  (input and output)
  207.                SSSSTTTTRRRRMMMMVVVV: Single precision array.
  208.                DDDDTTTTRRRRMMMMVVVV: Double precision array.
  209.                CCCCTTTTRRRRMMMMVVVV: Single precision complex array.
  210.                ZZZZTTTTRRRRMMMMVVVV: Double precision complex array.
  211.                Contains the vector _x.  On exit, the transformed vector
  212.                overwrites array _x.
  213.  
  214.      _i_n_c_x      Integer.  (input)
  215.                Specifies the increment for the elements of _x.  _i_n_c_x must not
  216.                be 0.
  217.  
  218. NNNNOOOOTTTTEEEESSSS
  219.      These routines are Level 2 Basic Linear Algebra Subprograms (Level 2
  220.      BLAS).
  221.  
  222.      When working backward (_i_n_c_x < 0), each routine starts at the end of the
  223.      vector and moves backward, as follows:
  224.  
  225.           _x(1-_i_n_c_x * (_n-1)), _x(1-_i_n_c_x * (_n-2)), ..., _x(1)
  226.  
  227.    DDDDaaaattttaaaa TTTTyyyyppppeeeessss
  228.      The following data types are described in this documentation:
  229.  
  230.           TTTTeeeerrrrmmmm UUUUsssseeeedddd                     DDDDaaaattttaaaa ttttyyyyppppeeee
  231.  
  232.      Fortran:
  233.  
  234.           Array dimensioned _n           xxxx((((nnnn))))
  235.  
  236.           Array of dimensions (_m,_n)     xxxx((((mmmm,,,,nnnn))))
  237.  
  238.           Character                     CCCCHHHHAAAARRRRAAAACCCCTTTTEEEERRRR
  239.  
  240.           Integer                       IIIINNNNTTTTEEEEGGGGEEEERRRR (IIIINNNNTTTTEEEEGGGGEEEERRRR****8888 for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  241.  
  242.           Single precision              RRRREEEEAAAALLLL
  243.  
  244.           Double precision              DDDDOOOOUUUUBBBBLLLLEEEE PPPPRRRREEEECCCCIIIISSSSIIIIOOOONNNN
  245.  
  246.           Single precision complex      CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  247.  
  248.           Double precision complex      DDDDOOOOUUUUBBBBLLLLEEEE CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  249.  
  250.      C/C++:
  251.  
  252.           Array dimensioned _n           xxxx[[[[_n]]]]
  253.  
  254.           Array of dimensions (_m,_n)     xxxx[[[[mmmm****nnnn]]]]
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. SSSSTTTTRRRRMMMMVVVV((((3333SSSS))))                                                            SSSSTTTTRRRRMMMMVVVV((((3333SSSS))))
  269.  
  270.  
  271.  
  272.           Character                     cccchhhhaaaarrrr
  273.  
  274.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  275.  
  276.           Single precision              ffffllllooooaaaatttt
  277.  
  278.           Double precision              ddddoooouuuubbbblllleeee
  279.  
  280.           Single precision complex      ssssccccssssllll____ccccoooommmmpppplllleeeexxxx
  281.  
  282.           Double precision complex      ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx
  283.  
  284.      C++ STL:
  285.  
  286.           Array dimensioned _n           xxxx[[[[_n]]]]
  287.  
  288.           Array of dimensions (_m,_n)     xxxx[[[[mmmm****nnnn]]]]
  289.  
  290.           Character                     cccchhhhaaaarrrr
  291.  
  292.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  293.  
  294.           Single precision              ffffllllooooaaaatttt
  295.  
  296.           Double precision              ddddoooouuuubbbblllleeee
  297.  
  298.           Single precision complex      ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>>
  299.  
  300.           Double precision complex      ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>>
  301.  
  302.      Note that you can explicitly declare multidimensional C/C++ arrays
  303.      provided that the array dimensions are swapped with respect to the
  304.      Fortran declaration (e.g., xxxx[[[[nnnn]]]][[[[mmmm]]]] in C/C++ versus xxxx((((mmmm,,,,nnnn)))) in Fortran).
  305.      To avoid a compiler type mismatch error in C++ (or a compiler warning
  306.      message in C), however, the array should be cast to a pointer of the
  307.      appropriate type when passed as an argument to a SCSL routine.
  308.  
  309. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  310.      IIIINNNNTTTTRRRROOOO____SSSSCCCCSSSSLLLL(3S), IIIINNNNTTTTRRRROOOO____BBBBLLLLAAAASSSS2222(3S)
  311.  
  312.      IIIINNNNTTTTRRRROOOO____CCCCBBBBLLLLAAAASSSS(3S) for information about using the C interface to Fortran 77
  313.      Basic Linear Algebra Subprograms (legacy BLAS) set forth by the Basic
  314.      Linear Algebra Subprograms Technical Forum.
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.                                                                         PPPPaaaaggggeeee 5555
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.